kanzi::Module Class Reference

Module is a class representing a functional module with its own metadata about the types it contains. More...

#include <kanzi/core/module/module.hpp>

Inheritance diagram for kanzi::Module:

Public Types
typedef vector< const Metaclass * >	MetaclassContainer
typedef MetaclassContainer::iterator	MetaclassIterator

Public Member Functions
virtual void	destroy ()
virtual MetaclassContainer	getMetaclassesOverride ()
	Module ()
virtual void	registerDebugRenderingFunctions (DebugRenderRegistry &)
	Registers the debug rendering functions of the module.
virtual void	registerMetadataOverride (ObjectFactory &)
	Registers the rest of the module metadata, such as loaders for types in the module.
void	setDomain (Domain *domain)
	Sets the domain.

Protected Member Functions
virtual	~Module ()=default
	Destructor.

Protected Attributes
Domain *	m_domain
	The domain this module is registered to.

Detailed Description

Module is a class representing a functional module with its own metadata about the types it contains.

Member Typedef Documentation

MetaclassContainer

typedef vector<const Metaclass*> kanzi::Module::MetaclassContainer

MetaclassIterator

typedef MetaclassContainer::iterator kanzi::Module::MetaclassIterator

Constructor & Destructor Documentation

Module()

kanzi::Module::Module ( )

inlineexplicit

~Module()

virtual kanzi::Module::~Module ( )

protectedvirtualdefault

Destructor.

Member Function Documentation

getMetaclassesOverride()

virtual MetaclassContainer kanzi::Module::getMetaclassesOverride ( )

inlinevirtual

Reimplemented in kanzi::LuaModule, kanzi::TargetPreviewPlugin, and kanzi::KanziComponentsModule.

destroy()

virtual void kanzi::Module::destroy ( )

inlinevirtual

registerMetadataOverride()

virtual void kanzi::Module::registerMetadataOverride ( ObjectFactory & )

inlinevirtual

Registers the rest of the module metadata, such as loaders for types in the module.

When registering a module, a domain calls this function.

Reimplemented in kanzi::ExampleApplication, kanzi::interop::ModuleBase, and kanzi::JvmModule.

registerDebugRenderingFunctions()

virtual void kanzi::Module::registerDebugRenderingFunctions ( DebugRenderRegistry & )

inlinevirtual

Registers the debug rendering functions of the module.

When registering a module, a domain calls this function.

See also

DebugRenderRegistry::addMapping

setDomain()

void kanzi::Module::setDomain ( Domain * domain )

inline

Sets the domain.

When registering a module, a domain calls this function.

Member Data Documentation

m_domain

Domain* kanzi::Module::m_domain

protected

The domain this module is registered to.

---

The documentation for this class was generated from the following file:

• kanzi/core/module/module.hpp